Inside Macintosh: Programming With the Text Encoding Conversion Manager /

Chapter 4 - Unicode Converter Reference / Unicode Converter Functions

Converting From Unicode /

DisposeUnicodeToTextInfo

Releases the memory allocated for the specified Unicode converter object.

pascal OSStatus DisposeUnicodeToTextInfo ( 
      UnicodeToTextInfo *ioUnicodeToTextInfo);

ioUnicode

A pointer to a Unicode converter object for converting from Unicode to a non-Unicode encoding. On input, you specify a Unicode converter object that your application created using the function CreateUnicodeToTextInfo (page 135) or CreateUnicodeToTextInfoByEncoding (page 136).

function result

A result code. See "Text Encoding Conversion Manager Result Codes" (page 42) in the chapter "Basic Text Types Reference."

DISCUSSION

The DisposeUnicodeToTextInfo function disposes of the Unicode converter object and releases the memory allocated for it. Your application should not attempt to dispose of the same Unicode converter object more than once.

You must use this function only to release the memory for a Unicode converter object that your application created through the function CreateUnicodeToTextInfo (page 135) or CreateUnicodeToTextInfoByEncoding (page 136). You must not use it for any other type of Unicode converter object.

The function returns noErr if it disposes of the Unicode converter object successfully. If your application specifies an invalid Unicode converter object, such as NULL, the function returns a paramErr result code.